home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1994 March / Internet Info CD-ROM (Walnut Creek) (March 1994).iso / networking / terms / kermit / b / ikmker.hlp < prev    next >
Encoding:
Text File  |  1992-09-29  |  16.9 KB  |  377 lines

  1. KERMIT
  2.  
  3.  
  4. Kermit-MUSIC is a program that implements the KERMIT file transfer protocol
  5. for IBM 370-series mainframes running the MUSIC/SP operating system.  It
  6. allows for the transfer of files between computers over asynchronous ASCII
  7. communications lines (attached to a 3705-style front end, such as the
  8. COMTEN, or to a Series/1 or 4994 running the Yale ASCII Terminal
  9. Communication System, or to an IBM 7171 ASCII Device Control Unit).  For
  10. more details, see SET CONTROLLER.
  11.  
  12. The calling format for Kermit-MUSIC is:
  13.  
  14.         +----------+-----------------------+
  15.         |          |                       |
  16.         |  KERMIT  |  [kercmd ... kercmd]  |
  17.         |          |                       |
  18.         +----------+-----------------------+
  19.  
  20. where kercmd is a valid Kermit-MUSIC command.  If no Kermit commands are
  21. supplied, Kermit-MUSIC will issue a prompt and wait for instructions.  When
  22. Kermit is invoked with command line arguments, it will exit and return to
  23. MUSIC after completing the specified command or commands.  Several commands
  24. may be given on the command line as long as they are separated by the
  25. linend character.  The command line may contain up to 130 characters.
  26.  
  27. Commands:
  28.  
  29.  
  30. SEND fn[<n-m>] [filespec]
  31.          Send a file or file group from MUSIC to the Kermit on the remote
  32.          system.  The wildcard characters "*" or "?" may be used.  A "*"
  33.          matches any string of characters from the current position to the
  34.          end of the field, including no characters at all; a "?" matches
  35.          any single character.  If the input contains wildcard characters
  36.          then all matching files will be sent.  The exact file name on the
  37.          foreign Kermit system may be specified; otherwise, Kermit-MUSIC
  38.          will make it up out of the MUSIC name.  A range of lines, "n"
  39.          through "m", may be specified for sending.
  40.  
  41. RECEIVE [fn]
  42.          Receive a file or file group from the other system.  If the
  43.          optional filename is not included, Kermit-MUSIC will use the name
  44.          provided by the other Kermit.  If that name is not a legal MUSIC
  45.          file name, Kermit-MUSIC will delete excessive characters from it,
  46.          and will change illegal characters to dollar signs.  Use the file
  47.          specification to indicate that the incoming file should be stored
  48.          under a different name.  The filespec may include a code to
  49.          designate the destination code.  If none is provided, the file
  50.          will be saved in the current working directory which is by default
  51.          your code.  Wildcards may not be used in any field.  If the
  52.          optional filespec is provided, but more than one file arrives, the
  53.          first file will be stored under the given filespec, and the
  54.          remainder will be stored under their own names in the current
  55.          working directory.
  56.  
  57. TAKE fn
  58.          Execute Kermit commands from the specified file.  The command file
  59.          may include TAKE commands.
  60.  
  61. SERVER
  62.          Kermit-MUSIC is capable of acting as a server.  In server mode,
  63.          Kermit-MUSIC can send and receive files, execute certain MUSIC
  64.          commands, execute a restricted set of Kermit commands, and perform
  65.          a variety of generic Kermit functions.  The following list shows
  66.          the typical local Kermit commands along with the server functions
  67.          they elicit.  Note that when Kermit-MUSIC is talking to a Kermit
  68.          server, these same commands may be used in the other direction.
  69.  
  70.           BYE                 log out of MUSIC
  71.           FINISH              exit from server mode
  72.           GET                 send a file or files from MUSIC
  73.           REMOTE COPY         copy a file or files
  74.           REMOTE CWD          set new "home" disk
  75.           REMOTE DIRECTORY    display file attributes
  76.           REMOTE ERASE        delete a file or files
  77.           REMOTE HELP         display this command summary
  78.           REMOTE HOST         execute a MUSIC command
  79.           REMOTE KERMIT       execute a Kermit-MUSIC command
  80.           REMOTE RENAME       rename a file or files
  81.           REMOTE SPACE        display disk allocations
  82.           REMOTE TYPE         display a file
  83.           SEND                receive a file or files onto MUSIC
  84.  
  85.          If your local Kermit does not support the REMOTE KERMIT command,
  86.          you may need to issue SET commands to select various options
  87.          before typing the SERVER command.  Once in server mode,
  88.          Kermit-MUSIC will await all further instructions from the user
  89.          Kermit on the other end of the connection.
  90.  
  91. CWD code
  92.          Change Working Directory - establish new default "code" for all
  93.          files.
  94.  
  95. SET parameter [value]
  96.          Establish or modify various parameters for file transfer.  You can
  97.          examine their values with the SHOW command.  Valid options are:
  98.  
  99.         ATOE [num1 num2]
  100.                 Modify the ASCII-to-EBCDIC translate table used by
  101.                 Kermit-MUSIC to conform to your system.  Specify the offset
  102.                 of the ASCII value within the table and the new value for
  103.                 that location.  Both "num1" and "num2" should be in the
  104.                 range 0-255 (decimal).  If "num1" and "num2" are omitted,
  105.                 restore the table to its default values.  Tables ETOA,
  106.                 TATOE, and TETOA may be modified in the same way.
  107.  
  108.         ATTRIBUTE [attribute] <ON | OFF>
  109.                 Allows or suppresses the exchange of Attribute packets.
  110.  
  111.         BLOCK num
  112.                 Determine the type of block check used during file
  113.                 transfer.  Valid options for "num" are: 1 (for a one
  114.                 character checksum), 2 (for a two character checksum) and 3
  115.                 (for a three character CRC).
  116.  
  117.         CONTROLLER <TTY | SERIES1 | GRAPHICS>
  118.                 Kermit-MUSIC automatically determines whether you are
  119.                 connected via a Series/1-style emulation controller or a
  120.                 TTY line.  This command is provided, though, so you can
  121.                 change connections and because Kermit may not be able to
  122.                 distinguish between Series/1 and graphics throughput
  123.                 devices.  For both of those, Kermit attempts to disable the
  124.                 3270 protocol conversion function by putting the controller
  125.                 into "transparent mode"; this allows Kermit packets to pass
  126.                 through intact.
  127.  
  128.         DEBUG <ON | OFF | RAW | I/O>
  129.                 If ON, keep a journal of all packets sent and received in
  130.                 the file KERMIT.LOG.  If the file already exists, it is
  131.                 overwritten.  If OFF, stop logging the packets.  If RAW,
  132.                 same as ON, but record packets "exactly" as sent or
  133.                 received (without translating to EBCDIC).  If I/O, same as
  134.                 ON, but record supplemental info for SERIES1 transfers.
  135.  
  136.         DELAY num
  137.                 How long to wait before sending the first packet.  Use a
  138.                 DELAY of 0 to suppress the extra 1-second pause for issuing
  139.                 the protocol-mode greetings.
  140.  
  141.         DELIM char
  142.                 Specifies a character to be interpreted by Kermit as a line
  143.                 delimiter in subsequent subcommands.
  144.  
  145.         DESTINATION code
  146.                 Specify a new user code.
  147.  
  148.         EOF <ON | OFF>
  149.                 ON means incoming text files are to be cut off at first
  150.                 Ctrl-Z character within the data, OFF means accept incoming
  151.                 text files in their entirety.
  152.  
  153.         FILE COLLISION <APPEND | BACKUP | DISCARD | OVERWRITE | RENAME>
  154.                 Specifies the action to take when a file is received that
  155.                 has the same name as an existing one.  BACKUP and RENAME
  156.                 are similar, but BACKUP renames the old file while RENAME
  157.                 renames the new one.  OVERWRITE is the default.
  158.  
  159.         FILE LONGLINE <FOLD | TRUNC | HALT>
  160.                 Specifies the action to take upon receiving records longer
  161.                 than the effective limit (for TEXT files).  With fixed
  162.                 record format, the limit is the logical record length, but
  163.                 with variable record format, the limit is 32K-1.
  164.  
  165.         FILE LRECL num
  166.                 Set the logical record length for incoming files to a "num"
  167.                 from 1 to 32767 (32K-1).  This variable is used only for
  168.                 fixed format and binary files.  The default is 80.
  169.  
  170.         FILE OVERWRITE <DEFAULT | PRESERVE>
  171.                 Specifies what attributes to use when writing a new file
  172.                 over an old one.  DEFAULT is the default.
  173.  
  174.         FILE RECFM <FIXED | VARIABLE>
  175.                 Set the record format to use for incoming files, using "F"
  176.                 for fixed format and "V" for variable format.  The default
  177.                 is variable.
  178.  
  179.         FILE TYPE <BINARY | TEXT | V-BINARY | D-BINARY>
  180.                 If BINARY, MUSIC Kermit treats each character as a string
  181.                 of bits and does not perform translation on the data.
  182.                 Also, carriage returns are not added to the end of outgoing
  183.                 records.  Incoming bytes are added to the end of the
  184.                 current record which is written out when the specified
  185.                 LRECL is reached.  If TEXT, MUSIC Kermit treats the file as
  186.                 plain text; ASCII-to-EBCDIC and EBCDIC-to-ASCII translation
  187.                 is performed on the data.  A carriage return-linefeed is
  188.                 appended to each outgoing record and is used to determine
  189.                 the end of each incoming record.  V-BINARY specifies
  190.                 variable-length-record binary data; like BINARY, except
  191.                 that a 2-byte length field precedes each outbound record,
  192.                 and is assumed for incoming records.  D-BINARY is similar,
  193.                 but the length field is a 5-byte ASCII decimal string.
  194.  
  195.         FOREIGN <PREFIX | SUFFIX> string
  196.                 The specified string is added to the beginning or end of
  197.                 outbound filespecs.
  198.  
  199.         INCOMPLETE <DISCARD | KEEP>
  200.                 The specified action is taken when a transfer is cancelled
  201.                 by the other Kermit before MUSIC has completely received
  202.                 the file.
  203.  
  204.         MARGIN <LEFT | RIGHT> column
  205.                 The specified margin is set for restricting the width of
  206.                 files to be sent.  A value of zero disables the specified
  207.                 margin.
  208.  
  209.         PROMPT string
  210.                 This command defines the character string that Kermit-MUSIC
  211.                 displays when asking for a command.  The prompt may be any
  212.                 string of up to 20 characters.  The default is
  213.                 "Kermit-MUSIC>".
  214.  
  215.         <SEND | RECEIVE> END-OF-LINE num
  216.                 If the remote system needs packets to be terminated by
  217.                 anything other than carriage return, specify the decimal
  218.                 value of the desired ASCII character.  "num" must be in the
  219.                 range 0 - 31 (decimal).
  220.  
  221.         RECEIVE PACKET-SIZE num
  222.                 Use the specified "num" as the maximum length for incoming
  223.                 packets.  The valid range is 26-1910, where 80 is the
  224.                 default.  SET RECEIVE PACKET-SIZE 95 or greater causes
  225.                 Kermit-MUSIC to negotiate reception of extended length
  226.                 packets with other Kermit programs that support this
  227.                 option.
  228.  
  229.         <SEND | RECEIVE> PAD-CHAR num
  230.                 Padding character to use between packets, NUL (ASCII 0) by
  231.                 default.
  232.  
  233.         <SEND | RECEIVE> PADDING num
  234.                 Number of copies of the interpacket padding character, zero
  235.                 by default.
  236.  
  237.         <SEND | RECEIVE> PARITY <MARK | NONE>
  238.                 Transparent-mode ASCII data from a SERIES1 or GRAPHICS
  239.                 device will typically have either all Mark parity (seven
  240.                 data bits with the eighth bit set) or no parity (eight data
  241.                 bits).  Kermit-MUSIC must know which kind of parity to
  242.                 expect in order to calculate checksums properly.  The SEND
  243.                 parity controls SERIES1 and GRAPHICS mode transfers.
  244.  
  245.         <SEND | RECEIVE> QUOTE char
  246.                 Control character quoting prefix, normally #.
  247.  
  248.         <SEND | RECEIVE> START-OF-PACKET num
  249.                 Control character to mark start of packet, normally Ctrl-A
  250.                 (ASCII 1).
  251.  
  252.         <SEND | RECEIVE> TIMEOUT num
  253.                 Number of seconds to wait for a packet before
  254.                 retransmitting.
  255.  
  256.         RETRY <INITIAL | PACKET> num
  257.                 Establish the threshold for retrying a particular packet.
  258.                 The default is 16 for initial and 5 for ordinary packets.
  259.  
  260.         SERVER-TIMEOUT num
  261.                 Number of seconds to wait for a packet in the server loop
  262.                 before sending a NAK.  Default is 120.
  263.  
  264.         SPEED num
  265.                 Specifies the lines speed to be assumed by Kermit-MUSIC in
  266.                 calculating the optimum packet size on a noisy line.  If
  267.                 the value is zero, such calculations are suppressed.  The
  268.                 default is 1200.
  269.  
  270.         SYSCMD <ON | OFF>
  271.                 Determine whether non-Kermit commands are assumed to be
  272.                 MUSIC commands.
  273.  
  274.         TABS-EXPAND <ON | OFF>
  275.                 Controls whether tabs in incoming text files are expended
  276.                 to blanks.
  277.  
  278.         TAKE ECHO <ON | OFF>
  279.                 Controls whether the contents of TAKE command files are
  280.                 echoed during execution.
  281.  
  282.         TAKE ERROR-ACTION <CONTINUE | HALT>
  283.                 Controls whether an error occuring during execution of a
  284.                 TAKE command file is fatal to the execution of that file.
  285.  
  286.         TEST <ON | OFF>
  287.                 Used for testing new versions, suppresses block check
  288.                 verification, allows start-of-packet to be set to anything
  289.                 at all.
  290.  
  291.         TTABLE <ON | OFF>
  292.                 Controls whether ATOE/ETOA or TATOE/TETOA are used for
  293.                 counteracting the system translations on TTY lines.
  294.  
  295.         8-BIT-QUOTE <ON | OFF | char>
  296.                 Control whether eighth-bit prefixing is done and specify
  297.                 the character to be used.
  298.  
  299. SHOW option
  300.          Display the values of any or all parameters that can be changed
  301.          with the SET command, except for ATOE and ETOA (see the TDUMP
  302.          command).
  303.  
  304. SPACE [letter]
  305.          Show the storage allocation on the specified MUSIC code.
  306.  
  307. STATUS
  308.          Return the status of the previous command.  The response will
  309.          either display the message "No errors", or the last error
  310.          encountered.  The throuput statistics for the last transfer are
  311.          also shown.
  312.  
  313. TDUMP <table-name | NAMES>
  314.          Display the contents of "table-name" since it can be modified
  315.          using the SET command.  The ATOE, ETOA, TATOE, and TETOA tables
  316.          can be 'dumped' (also, the list of files sent in the last
  317.          transfer).
  318.  
  319. GIVE table-name fn
  320.          Save the contents of "table-name" as a TAKE file containing SET
  321.          commands to change the default into the current arrangement.
  322.  
  323. ECHO line
  324.          Display the line at your terminal.
  325.  
  326. XECHO line
  327.          Display the line at your Series/1 terminal in transparent mode.
  328.  
  329. TYPE fn
  330.          Display the specified file at your terminal.
  331.  
  332. XTYPE fn
  333.          Display  the   specified  file   at  your   Series/1  terminal  in
  334.          transparent mode.
  335.  
  336. HOST     Issue a MUSIC command from within Kermit-MUSIC.
  337.  
  338. DIR      Similar to MUSIC LIBRARY
  339.  
  340. SPACE    Same as SHOW.
  341.  
  342. HELP     Display a message that explains Kermit-MUSIC commands.
  343.  
  344. EXIT     Exit from KERMIT back to the host operating system.
  345.  
  346. QUIT     Synonym for EXIT.
  347.  
  348. ?        List all legal Kermit-MUSIC commands.
  349.  
  350.  
  351. You may use the help ("?") feature while typing Kermit-MUSIC commands.  A
  352. question mark typed at almost any point in a command, followed by a
  353. carriage return, produces a brief description of what is expected or
  354. possible at that point.
  355.  
  356. Usage Notes:
  357.  
  358. 1.  To use MUSIC Kermit though a 3705-style linemode connection, you should
  359.     be sure  to set  the following  parameters:   ECHO LOCAL (half duplex),
  360.     PARITY MARK (or whatever  your system uses), FLOW-CONTROL  NONE (rather
  361.     than XON/XOFF), HANDSHAKE NONE, TIMER ON.
  362.  
  363. 2.  To use MUSIC  Kermit through a  Series/1-style protocol converter,  use
  364.     ECHO REMOTE (full duplex), FLOW-CONTROL XON/XOFF, HANDSHAKE NONE, TIMER
  365.     ON, and PARITY to EVEN or whatever your front end requires.
  366.  
  367. 3.  The current version  of Kermit-MUSIC does  not support timeouts.   Your
  368.     local Kermit program should supply them (SET TIMER ON enables  timeouts
  369.     in most microcomputer Kermits).
  370.  
  371. 4.  When sending  packets to  Kermit-MUSIC, the  micro must  use a carriage
  372.     return as the end-of-line character.  Both TTY and Series/1 connections
  373.     require a carriage return to terminate a read from the terminal;  thus,
  374.     if  any  other  character  is  used,  Kermit-MUSIC  will  never get the
  375.     packets.
  376.  
  377.